<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>AtkEditableText</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="prev" href="AtkDocument.html" title="AtkDocument">
<link rel="next" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
<link rel="index" href="ix01.html" title="Index">
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
<link rel="index" href="ix03.html" title="Index of new symbols in ATK 1.3">
<link rel="index" href="ix04.html" title="Index of new symbols in ATK 1.4">
<link rel="index" href="ix05.html" title="Index of new symbols in ATK 1.6">
<link rel="index" href="ix06.html" title="Index of new symbols in ATK 1.9">
<link rel="index" href="ix07.html" title="Index of new symbols in ATK 1.12">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="AtkDocument.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkGObjectAccessible.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#AtkEditableText.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#AtkEditableText.description" class="shortcut">Description</a>
                   | 
                  <a href="#AtkEditableText.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#AtkEditableText.implementations" class="shortcut">Known Implementations</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="AtkEditableText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="AtkEditableText.top_of_page"></a>AtkEditableText</span></h2>
<p>AtkEditableText — The ATK interface implemented by components containing user-editable text content.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="AtkEditableText.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
                    <a class="link" href="AtkEditableText.html#AtkEditableText-struct" title="AtkEditableText">AtkEditableText</a>;
<a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            <a class="link" href="AtkEditableText.html#atk-editable-text-set-run-attributes" title="atk_editable_text_set_run_attributes ()">atk_editable_text_set_run_attributes</a>
                                                        (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);
void                <a class="link" href="AtkEditableText.html#atk-editable-text-set-text-contents" title="atk_editable_text_set_text_contents ()">atk_editable_text_set_text_contents</a> (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *string);
void                <a class="link" href="AtkEditableText.html#atk-editable-text-insert-text" title="atk_editable_text_insert_text ()">atk_editable_text_insert_text</a>       (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *string,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> length,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> *position);
void                <a class="link" href="AtkEditableText.html#atk-editable-text-copy-text" title="atk_editable_text_copy_text ()">atk_editable_text_copy_text</a>         (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
void                <a class="link" href="AtkEditableText.html#atk-editable-text-cut-text" title="atk_editable_text_cut_text ()">atk_editable_text_cut_text</a>          (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
void                <a class="link" href="AtkEditableText.html#atk-editable-text-delete-text" title="atk_editable_text_delete_text ()">atk_editable_text_delete_text</a>       (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
void                <a class="link" href="AtkEditableText.html#atk-editable-text-paste-text" title="atk_editable_text_paste_text ()">atk_editable_text_paste_text</a>        (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> position);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkEditableText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  GInterface
   +----AtkEditableText
</pre>
</div>
<div class="refsect1" lang="en">
<a name="AtkEditableText.implementations"></a><h2>Known Implementations</h2>
<p>
AtkEditableText is implemented by
 <a class="link" href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="AtkEditableText.description"></a><h2>Description</h2>
<p>
<a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> should be implemented by UI components which contain
text which the user can edit, via the <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> corresponding to that
component (see <a class="link" href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>).
</p>
<p>
<a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is a subclass of <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>, and as such, an object which
implements <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is by definition an <a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> implementor as well.
</p>
</div>
<div class="refsect1" lang="en">
<a name="AtkEditableText.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="AtkEditableText-struct"></a><h3>AtkEditableText</h3>
<pre class="programlisting">typedef struct _AtkEditableText AtkEditableText;</pre>
<p>
The AtkEditableText structure does not contain any fields.

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-set-run-attributes"></a><h3>atk_editable_text_set_run_attributes ()</h3>
<pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"
>gboolean</a>            atk_editable_text_set_run_attributes
                                                        (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);</pre>
<p>
Sets the attributes for a specified range. See the ATK_ATTRIBUTE
macros (such as <span class="type">ATK_ATTRIBUTE_LEFT_MARGIN</span>) for examples of attributes 
that can be set. Note that other attributes that do not have corresponding
ATK_ATTRIBUTE macros may also be set for certain text widgets.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attrib_set</code></em> :</span></p></td>
<td> an <a class="link" href="AtkText.html#AtkAttributeSet" title="AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_offset</code></em> :</span></p></td>
<td> start of range in which to set attributes
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_offset</code></em> :</span></p></td>
<td> end of range in which to set attributes
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"
><code class="literal">TRUE</code></a> if attributes successfully set for the specified
range, otherwise <a
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"
><code class="literal">FALSE</code></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-set-text-contents"></a><h3>atk_editable_text_set_text_contents ()</h3>
<pre class="programlisting">void                atk_editable_text_set_text_contents (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *string);</pre>
<p>
Set text contents of <em class="parameter"><code>text</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td> string to set for text contents of <em class="parameter"><code>text</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-insert-text"></a><h3>atk_editable_text_insert_text ()</h3>
<pre class="programlisting">void                atk_editable_text_insert_text       (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *string,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> length,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> *position);</pre>
<p>
Insert text at a given position.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td> the text to insert
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td> the length of text to insert, in bytes
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td> The caller initializes this to 
the position at which to insert the text. After the call it
points at the position after the newly inserted text.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-copy-text"></a><h3>atk_editable_text_copy_text ()</h3>
<pre class="programlisting">void                atk_editable_text_copy_text         (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Copy text from <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em> 
to the clipboard.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
<td> start position
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
<td> end position
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-cut-text"></a><h3>atk_editable_text_cut_text ()</h3>
<pre class="programlisting">void                atk_editable_text_cut_text          (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Copy text from <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>
to the clipboard and then delete from the widget.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
<td> start position
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
<td> end position
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-delete-text"></a><h3>atk_editable_text_delete_text ()</h3>
<pre class="programlisting">void                atk_editable_text_delete_text       (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Delete text <em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
<td> start position
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
<td> end position
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="atk-editable-text-paste-text"></a><h3>atk_editable_text_paste_text ()</h3>
<pre class="programlisting">void                atk_editable_text_paste_text        (<a class="link" href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
                                                         <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"
>gint</a> position);</pre>
<p>
Paste text from clipboard to specified <em class="parameter"><code>position</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td> an <a class="link" href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td> position to paste
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="AtkEditableText.see-also"></a><h2>See Also</h2>
<p>
<a class="link" href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</p>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.10</div>
</body>
</html>
